Android客户端接入

接入步骤

下载SDK

登录号码认证产品控制台，在概览页面右侧API&SDK区域，单击立即下载，进入API&SDK页面，根据页面提示下载并解压对应SDK。

创建认证方案

您导入项目或调用API接口时，会用到方案Code或方案编码等参数信息，请先在号码认证产品控制台，创建图形认证方案，获取方案Code等参数信息。

导入SDK

将SDK包中的.aar文件（包括alicom_captcha_android_vx.y.z_date.aar ）拖拽到工程中的libs文件夹下，检查.aar文件是否被添加到Library ，并在项目的build.gradle下添加如下代码：

repositories {
        flatDir {
            dirs 'libs'
        }
  }

给.aar包添加依赖（AAR默认不传递第三方依赖，需要您手动添加）：

implementation(name: 'alicom_captcha_android_vx.y.z_date', ext: 'aar')

非Kotlin工程配置

在根目录build.gradle配置：

ext.kotlin_version = "1.4.10"
dependencies {
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}

在引入模块build.gradle配置：

apply plugin: 'kotlin-android'
dependencies {
      implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}

添加权限

<!--必选-默认申请-->
<uses-permission android:name="android.permission.INTERNET" />
<!--必选-默认没有申请-->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!--可选-6.0或以上需动态申请（存储日志方便分析报错，日志路径 /sdcard/Android/data/Your
PackageName/files/Alicom/captcha_log.txt）-->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

混淆规则

验证SDK已做混淆处理，集成时请带上混淆规则，勿再次混淆SDK。

-dontwarn com.geetest.gtcaptcha4.alicom.**
-keep class com.geetest.gtcaptcha4.alicom.**{*;}

若使用资源混淆工具，请添加白名单配置：

"R.string.gt4_*",
"R.style.gt4_*",

配置接口

初始化

SDK初始化配置信息，可放在onCreate或onCreateView方法进行初始化。

public static AlicomCaptchaClient getClient(Context context);
public AlicomCaptchaClient init(String captchaId);
public AlicomCaptchaClient init(String captchaId, AlicomCaptchaConfig config)

启动验证

开始验证流程。

public void verifyWithCaptcha();

取消验证

取消验证流程，关闭验证窗口。

public void cancel();

开启/关闭日志监控

设置开启或关闭日志打印监控。

public void setLogEnable(boolean enable);

获取验证回调

public AlicomCaptchaClient addOnSuccessListener(OnSuccessListener listener);
public AlicomCaptchaClient addOnFailureListener(OnFailureListener listener);

代码示例

AlicomCaptchaClient.addOnSuccessListener(new
AlicomCaptchaClient.OnSuccessListener() {
   @Override
   public void onSuccess(boolean status, String response) {
       if(status){
         // TODO 开启二次验证
       }else {
         // TODO 用户答案验证错误
       }
   }
}).addOnFailureListener(new AlicomCaptchaClient.OnFailureListener() {
   @Override
   public void onFailure(String error) {
   }
})

销毁资源

在onDestroy生命周期销毁资源。

public void onDestroy(){
    super.onDestroy();
    if(AlicomCaptchaClient != null){
       AlicomCaptchaClient.destroy();
     }
}

横竖屏切换

@Override
public void onConfigurationChanged(Configuration newConfig) {
    super.onConfigurationChanged(newConfig);
    if(AlicomCaptchaClient != null){
       AlicomCaptchaClient.configurationChanged(newConfig);
    }
}

@Override
public void onViewCreated(View view, Bundle savedInstanceState){
   super.onViewCreated(view, savedInstanceState);
   AlicomCaptchaConfig config = new AlicomCaptchaConfig.Builder()
            .setDebug(true) // TODO 线上务必关闭
            .setLanguage("zh")
            .setTimeOut(10000)
            .setCanceledOnTouchOutside(true)
            .build();
   AlicomCaptchaClient = AlicomCaptchaClient.getClient(activity)
            .init("your captcha_id", config);
}

private void click(){
    AlicomCaptchaClient.addOnSuccessListener(new
AlicomCaptchaClient.OnSuccessListener {
             @Override
             public void onSuccess(boolean status, String response) {
                 if(status){
                     // TODO 开启二次验证
                 }else {
                    // TODO 用户答案验证错误
                 }
             }
   })
   .addOnFailureListener(new AlicomCaptchaClient.OnFailureListener {
       @Override
       public void onFailure(String error) {
       }
   })
   .verifyWithCaptcha();
}

private void click(){
    AlicomCaptchaConfig config = new AlicomCaptchaConfig.Builder()
             .setDebug(true) // TODO 线上务必关闭
             .setLanguage("zh")
             .setTimeOut(10000)
             .setCanceledOnTouchOutside(true)
             .build();
   AlicomCaptchaClient = AlicomCaptchaClient.getClient(activity)
             .init("your captcha_id", config)
             .addOnSuccessListener(new AlicomCaptchaClient.OnSuccessListener {
                 @Override
                 public void onSuccess(boolean status, String response) {
                    if(status){
                        // TODO 开启二次验证
                    }else {
                        // TODO 用户答案验证错误
                    }
              }
   })
   .addOnFailureListener(new AlicomCaptchaClient.OnFailureListener {
                 @Override
                 public void onFailure(String error) {
                 }
   })
   .verifyWithCaptcha();
}

参数配置

通过AlicomCaptchaConfig.Builder类配置参数。